<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Language" content="en-us" />
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="../../../doc/src/boostbook.css" />
<title>Running Regression Test Reports</title>
</head>

<body>
  <h1>Running Regression Test Reports</h1>

  <h2>Introduction</h2>

  <p>
    This page describes how to generate the <a
      href="http://boost.org/development/tests/master/developer/summary.html">
      Regression Test Reports</a>. It is of interest primarily to people authorized
    by the release managers to run the reports.
  </p>

  <h2>Prerequisites</h2>

  <ul>
    <li>A public ssh key.</li>
    <li><b>Linux</b>. In theory it should be possible to run the run the
      reports on most modern operating system, including OS X and Windows (under
      <code> bash</code>), but all testing and current use has been on Linux.
      Works fine in a Linux VirtualBox virtual machine running on a Windows
      host.</li>
    <li><b>Git</b> installed.</li>
    <li>A C++ compiler installed.</li>
    <li>The '7za' program from 7-zip.</li>
    <li>Python.</li>
  </ul>

  <h2>Initial setup</h2>

  <p>Send your public ssh key to Rene Rivera.</p>
  <p>Run once only:</p>
  <blockquote>
    <pre>
cd ~                   # or some other directory of your choice
mkdir boost-reports    # or some other name of your choice
    </pre>
  </blockquote>

  <h2>Run reports</h2>

  <p>This step performs the following actions:</p>
  <ul>
    <li>Updates its internal procedures from the git public repository.</li>
    <li>Downloads current result zip files from an ftp server.</li>
    <li>Generates the HTML reports. (Now using a C++ program that is much
      faster than the old XSLT process.)</li>
    <li>Uploads a zip file containing the reports to a web server.</li>
  </ul>
  <p>To run:</p>
  <blockquote>
    <pre>
cd ~/boost/boost-reports # i.e. the directory created above
curl -o build_results_all.sh https://raw.githubusercontent.com/boostorg/regression/develop/reports/src/build_results_all.sh
chmod +x build_results_all.sh
./build_results_all.sh
    </pre>
    <p>In place of "curl" you could use "wget" or any other web command
      client.</p>
  </blockquote>

  <p>The build_results_all.sh script generates log files for the report
    generation (develop.log and master.log). They are handy for debugging
    problems.</p>

  <h2>To Do</h2>

  <ul>
  </ul>

  <h2>Acknowledgements</h2>

  <p>
    Thanks to Tom Kent, Steven Watanabe, and Rene Rivera for illuminating
    various dark corners of how reporting works.<span></span>
  </p>
  <hr />

  <p>Copyright Beman Dawes 2014. Copyright Rene Rivera 2014-2015.</p>

  <p>
    Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost
      Software License, Version 1.0</a>.
  </p>
  <p>&nbsp;</p>

</body>

</html>
